<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pybindgen.module.SubModule</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pybindgen-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="pybindgen-module.html">Package&nbsp;pybindgen</a> ::
        <a href="pybindgen.module-module.html">Module&nbsp;module</a> ::
        Class&nbsp;SubModule
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="pybindgen.module.SubModule-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class SubModule</h1><p class="nomargin-top"><span class="codelink"><a href="pybindgen.module-pysrc.html#SubModule">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_pybindge_64" name="uml_class_diagram_for_pybindge_64">
<area shape="rect" href="pybindgen.module.SubModule-class.html#__init__" title="Note: this is an abstract base class, see Module" alt="" coords="17,753,420,772"/>
<area shape="rect" href="pybindgen.module.SubModule-class.html" title="pybindgen.module.SubModule" alt="" coords="16,728,421,773"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#current_section" title="pybindgen.module.ModuleBase.current_section" alt="" coords="65,377,372,396"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#name" title="pybindgen.module.ModuleBase.name" alt="" coords="65,396,372,415"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#get_current_section" title="pybindgen.module.ModuleBase.get_current_section" alt="" coords="65,417,372,436"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#begin_section" title="Declare that types and functions registered with the module in the future &#160;belong to the section given by that section_name parameter, until a &#160;matching end_section() is called." alt="" coords="65,436,372,455"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#end_section" title="Declare the end of a section, i.e." alt="" coords="65,455,372,473"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#get_name" title="pybindgen.module.ModuleBase.get_name" alt="" coords="65,473,372,492"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#set_name" title="pybindgen.module.ModuleBase.set_name" alt="" coords="65,492,372,511"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#get_submodule" title="get a submodule by its name" alt="" coords="65,511,372,529"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#get_root" title="Returns: &#160;the root Module (even if it is self)" alt="" coords="65,529,372,548"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#set_strip_prefix" title="Sets the prefix string to be used when transforming a C function name into &#160;the python function name; the given prefix string is removed from the C &#160;function name." alt="" coords="65,548,372,567"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#set_c_function_name_transformer" title="Sets the function to be used when transforming a C function name into the &#160;python function name; the given given function is called like this:" alt="" coords="65,567,372,585"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#add_include" title="Adds an additional include directive, needed to compile this python module" alt="" coords="65,585,372,604"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#add_function" title="Add a function to the module/namespace." alt="" coords="65,604,372,623"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#add_custom_function_wrapper" title="Add a function, using custom wrapper code, to the module/namespace." alt="" coords="65,623,372,641"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#register_type" title="Register a type wrapper with the module, for easy access in the future." alt="" coords="65,641,372,660"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#add_typedef" title="Declares an equivalent to a typedef in C:" alt="" coords="65,679,372,697"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html" title="ModuleBase objects can be indexed dictionary style to access contained types." alt="" coords="64,360,373,699"/>
<area shape="rect" href="javascript:void(0);" title="hash(x)" alt="" coords="159,28,279,47"/>
<area shape="rect" href="javascript:void(0);" title="cmp(x,y)" alt="" coords="159,49,279,68"/>
<area shape="rect" href="javascript:void(0);" title="dict.__contains__" alt="" coords="159,68,279,87"/>
<area shape="rect" href="javascript:void(0);" title="del x[y]" alt="" coords="159,87,279,105"/>
<area shape="rect" href="javascript:void(0);" title="x==y" alt="" coords="159,105,279,124"/>
<area shape="rect" href="javascript:void(0);" title="x&gt;=y" alt="" coords="159,124,279,143"/>
<area shape="rect" href="javascript:void(0);" title="x.__getattribute__(&#39;name&#39;) &lt;==&gt; x.name" alt="" coords="159,143,279,161"/>
<area shape="rect" href="javascript:void(0);" title="x[y]" alt="" coords="159,161,279,180"/>
<area shape="rect" href="javascript:void(0);" title="x&gt;y" alt="" coords="159,180,279,199"/>
<area shape="rect" href="javascript:void(0);" title="iter(x)" alt="" coords="159,199,279,217"/>
<area shape="rect" href="javascript:void(0);" title="x&lt;=y" alt="" coords="159,217,279,236"/>
<area shape="rect" href="javascript:void(0);" title="len(x)" alt="" coords="159,236,279,255"/>
<area shape="rect" href="javascript:void(0);" title="x&lt;y" alt="" coords="159,255,279,273"/>
<area shape="rect" href="javascript:void(0);" title="x!=y" alt="" coords="159,273,279,292"/>
<area shape="rect" href="javascript:void(0);" title="dict.values" alt="" coords="159,311,279,329"/>
<area shape="rect" href="javascript:void(0);" title="dict() &#45;&gt; new empty dictionary." alt="" coords="157,11,280,331"/>
</map>
  <img src="uml_class_diagram_for_pybindge_64.gif" alt='' usemap="#uml_class_diagram_for_pybindge_64" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><pre class="literalblock">
new empty dictionary

</pre></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pybindgen.module.SubModule-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">parent</span>,
        <span class="summary-sig-arg">docstring</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">cpp_namespace</span>=<span class="summary-sig-default">None</span>)</span><br />
      Note: this is an abstract base class, see <a 
      href="pybindgen.module.Module-class.html" class="link">Module</a></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.module-pysrc.html#SubModule.__init__">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___48-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for___init___48-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for___init___48" name="call_graph_for___init___48">
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#__init__" title="ModuleBase.__init__()" alt="" coords="547,5,768,37"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#add_cpp_namespace" title="ModuleBase.add_cpp_namespace()" alt="" coords="7,5,343,37"/>
<area shape="rect" href="pybindgen.module.SubModule-class.html#__init__" title="__init__()" alt="" coords="393,5,497,37"/>
</map>
  <img src="call_graph_for___init___48.gif" alt='' usemap="#call_graph_for___init___48" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pybindgen.module.ModuleBase-class.html">ModuleBase</a></code></b>:
      <code><a href="pybindgen.module.ModuleBase-class.html#__repr__">__repr__</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#add_class">add_class</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#add_container">add_container</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#add_cpp_namespace">add_cpp_namespace</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#add_custom_function_wrapper">add_custom_function_wrapper</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#add_enum">add_enum</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#add_function">add_function</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#add_include">add_include</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#add_struct">add_struct</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#add_typedef">add_typedef</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#begin_section">begin_section</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#declare_one_time_definition">declare_one_time_definition</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#do_generate">do_generate</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#end_section">end_section</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#generate_forward_declarations">generate_forward_declarations</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#get_current_section">get_current_section</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#get_module_path">get_module_path</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#get_name">get_name</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#get_namespace_path">get_namespace_path</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#get_root">get_root</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#get_submodule">get_submodule</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#register_type">register_type</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#set_c_function_name_transformer">set_c_function_name_transformer</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#set_name">set_name</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#set_strip_prefix">set_strip_prefix</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>dict</code></b>:
      <code>__cmp__</code>,
      <code>__contains__</code>,
      <code>__delitem__</code>,
      <code>__eq__</code>,
      <code>__ge__</code>,
      <code>__getattribute__</code>,
      <code>__getitem__</code>,
      <code>__gt__</code>,
      <code>__iter__</code>,
      <code>__le__</code>,
      <code>__len__</code>,
      <code>__lt__</code>,
      <code>__ne__</code>,
      <code>__new__</code>,
      <code>__setitem__</code>,
      <code>__sizeof__</code>,
      <code>clear</code>,
      <code>copy</code>,
      <code>fromkeys</code>,
      <code>get</code>,
      <code>has_key</code>,
      <code>items</code>,
      <code>iteritems</code>,
      <code>iterkeys</code>,
      <code>itervalues</code>,
      <code>keys</code>,
      <code>pop</code>,
      <code>popitem</code>,
      <code>setdefault</code>,
      <code>update</code>,
      <code>values</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Class Variables</span></td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>dict</code></b>:
      <code>__hash__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Properties</span></td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pybindgen.module.ModuleBase-class.html">ModuleBase</a></code></b>:
      <code><a href="pybindgen.module.ModuleBase-class.html#current_section">current_section</a></code>,
      <code><a href="pybindgen.module.ModuleBase-class.html#name">name</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>,
        <span class="sig-arg">parent</span>,
        <span class="sig-arg">docstring</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">cpp_namespace</span>=<span class="sig-default">None</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pybindgen.module-pysrc.html#SubModule.__init__">source&nbsp;code</a></span>&nbsp;
    <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___48-div');return false;">call&nbsp;graph</a></span>&nbsp;</td>
  </tr></table>
  <div style="display:none" id="call_graph_for___init___48-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for___init___48" name="call_graph_for___init___48">
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#__init__" title="ModuleBase.__init__()" alt="" coords="547,5,768,37"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#add_cpp_namespace" title="ModuleBase.add_cpp_namespace()" alt="" coords="7,5,343,37"/>
<area shape="rect" href="pybindgen.module.SubModule-class.html#__init__" title="__init__()" alt="" coords="393,5,497,37"/>
</map>
  <img src="call_graph_for___init___48.gif" alt='' usemap="#call_graph_for___init___48" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

  <p>Note: this is an abstract base class, see <a 
  href="pybindgen.module.Module-class.html" class="link">Module</a></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>parent</code></strong> - parent <a href="pybindgen.module.Module-class.html" 
          class="link">module</a> (i.e. the one that contains this 
          submodule)</li>
        <li><strong class="pname"><code>name</code></strong> - name of the submodule</li>
        <li><strong class="pname"><code>docstring</code></strong> - docstring to use for this module</li>
        <li><strong class="pname"><code>cpp_namespace</code></strong> - C++ namespace component associated with this module</li>
    </ul></dd>
    <dt>Returns: <pre class="literalblock">
new empty dictionary

</pre></dt>
        <dd>a new module object</dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pybindgen-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Jul 12 17:23:25 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
